Skip to content

feat: autogenerated configuration page#938

Merged
rhamzeh merged 6 commits intomainfrom
feat/add-auto-generated-config-page
Mar 7, 2025
Merged

feat: autogenerated configuration page#938
rhamzeh merged 6 commits intomainfrom
feat/add-auto-generated-config-page

Conversation

@rhamzeh
Copy link
Member

@rhamzeh rhamzeh commented Jan 21, 2025

Description

This adds a page that lists all of the OpenFGA server configuration options based on the https://github.com/openfga/openfga/blob/main/.config-schema.json

Preview: https://openfga.dev/pr-preview/pr-938/docs/getting-started/setup-openfga/configuration

Follow up tasks include:

  • Add the script to autogenerate this page (feat: add script to autogenerate configuration page #958)
  • Add a github workflow to autogenerate this page on every build
  • Add a github workflow on the openfga/openfga repo that would trigger this workflow on every merge to main
  • Update the script and the workflows so it is only triggered on a release and always gets the data for the latest stable release
  • Make the table more readable without scrolling
Screenshot 2025-01-21 at 9 03 05 AM Screenshot 2025-01-21 at 9 03 18 AM Screenshot 2025-01-21 at 9 03 26 AM

References

Closes #267

Review Checklist

  • I have clicked on "allow edits by maintainers".
  • I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
  • The correct base branch is being used, if not main
  • I have added tests to validate that the change in functionality is working as expected

@rhamzeh rhamzeh requested review from a team as code owners January 21, 2025 14:07
@rhamzeh rhamzeh force-pushed the feat/add-auto-generated-config-page branch 2 times, most recently from 65b823a to a586759 Compare January 21, 2025 14:14
@github-actions
Copy link
Contributor

github-actions bot commented Jan 21, 2025

PR Preview Action v1.4.8
🚀 Deployed preview to https://openfga.github.io/openfga.dev/pr-preview/pr-938/
on branch gh-pages at 2025-03-06 19:30 UTC

@rhamzeh rhamzeh force-pushed the feat/add-auto-generated-config-page branch from a586759 to 8c17167 Compare February 13, 2025 02:20
@rhamzeh rhamzeh enabled auto-merge (squash) February 21, 2025 11:40
@rhamzeh rhamzeh merged commit 6f6d347 into main Mar 7, 2025
12 checks passed
@rhamzeh rhamzeh deleted the feat/add-auto-generated-config-page branch March 7, 2025 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Load the OpenFGA server config file into a table and show corresponding env variables

2 participants